The VIEWAPP integration can be divided into few parts:
1. Creating an integration user profile
2. Setting up the integration via the VIEWAPP API
3. Setting up the Webhook
4. Typical setup
Creating an integration user profile
We recommend creating a separate user profile for customizing the integration. How to create a user is described on the page
Adding a user to VIEWAPP.
The difference between an integration profile and a regular profile is the checkbox "
Allow access to integrapi (api for integration)"
Setting up the integration via the VIEWAPP API
The next step is to configure the use of the VIEWAPP API methods.
The functions available in the API actually repeat the functionality of the web interface.
Detailed information about the methods themselves with a description of the technical component can be found on the
Integrapi page.
Setting up the Webhook
The next step is to configure the receipt of the Webhook.
Up-to-date information on how webhook works can be found on the
Webhook page.
Typical setup
As a result, the configured integration should correspond to the following scheme:
- Through the web interface, the necessary Inspection Template are configured and visibility is differentiated by Access Groups
- Through integrapi, you can configure the creation and management of Users - that is, the creation of a full-fledged account with the assignment of the required Role and Access Groups
- Through webhook, you can configure the receipt of information about changes occurring with inspections (in particular, about Creating and changing the Status of inspections)
- After receiving information about the Created inspection or about changing the Inspection Status, receiving complete information about the inspection is configured via integrapi
Important! Consider the features of working with integrapi and webhook:
- it is necessary to create a separate account exclusively for use with integrapi
- it is necessary to wait for a response to each request made in integrapi BEFORE sending the next request
- it is necessary to cache the token in order not to require authorization before each request
- it is necessary to process webhooks, namely, to filter according to the desired inspection template and/or user
You can always ask a company representative if you have questions about setting up integration.